/*
 * Copyright [2013-2021], Alibaba Group Holding Limited
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.alibaba.polardbx.sequence;

import com.alibaba.polardbx.sequence.exception.SequenceException;

/**
 * @author nianbing
 */
public interface Sequence {

    /**
     * Get next sequence value.
     */
    long nextValue() throws SequenceException;

    /**
     * Return the maximum value in a batch of sequence values.
     */
    long nextValue(int size) throws SequenceException;

    /**
     * Get current sequence value, i.e. last assigned sequence value in current session
     */
    long currValue() throws SequenceException;

    /**
     * Exhaust values in currently cached range for Group Sequence.
     */
    boolean exhaustValue() throws SequenceException;

    /**
     * Update explicit value.
     */
    void updateValue(long value) throws SequenceException;

}
